org.eclipse.vtp.framework.common.commands
Class ForwardCommand

java.lang.Object
  org.eclipse.vtp.framework.common.commands.ControllerCommand
      org.eclipse.vtp.framework.common.commands.ForwardCommand

All Implemented Interfaces:

ICommand

public final class ForwardCommand
extends ControllerCommand

A command that tells the process engine to terminate the current process and pass control to another process.

Author:

Lonnie Pryor

Constructor Summary

ForwardCommand()
Creates a new ForwardCommand.

Method Summary

java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
java.lang.String	getgVariableValue(java.lang.String targetVariableName) Returns the name of the variable in the current process that will be set as the specified variable in the target process.
java.lang.String	getTargetProcessURI() Returns the URI identifying the process to transfer control to.
java.lang.String[]	getVariableNames() Returns the names of the variables that will be passed to the target process.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
void	setTargetProcessURI(java.lang.String targetProcessURI) Sets the URI identifying the process to transfer control to.
void	setVariableValue(java.lang.String targetVariableName, java.lang.String localVariableName) Sets the name of the variable in the current process that will be set as the specified variable in the target process.

Methods inherited from class org.eclipse.vtp.framework.common.commands.ControllerCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForwardCommand

public ForwardCommand()

Creates a new ForwardCommand.

Method Detail

getTargetProcessURI

public java.lang.String getTargetProcessURI()

Returns the URI identifying the process to transfer control to.

Returns:

The URI identifying the process to transfer control to.

setTargetProcessURI

public void setTargetProcessURI(java.lang.String targetProcessURI)

Sets the URI identifying the process to transfer control to.

Parameters:

targetProcessURI - The URI identifying the process to transfer control to.

getVariableNames

public java.lang.String[] getVariableNames()

Returns the names of the variables that will be passed to the target process.

Returns:

The names of the variables that will be passed to the target process.

getgVariableValue

public java.lang.String getgVariableValue(java.lang.String targetVariableName)

Returns the name of the variable in the current process that will be set as the specified variable in the target process.

Parameters:

targetVariableName - The name of the variable in the target process.

Returns:

The name of the variable in the current process that will be set as the specified variable in the target process.

setVariableValue

public void setVariableValue(java.lang.String targetVariableName,
                             java.lang.String localVariableName)

Sets the name of the variable in the current process that will be set as the specified variable in the target process.

Parameters:

targetVariableName - The name of the variable in the target process.

localVariableName - The name of the variable in the current process to pass to the target process.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.